home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Diamond Collection / The Diamond Collection (Software Vault)(Digital Impact).ISO / cdr18 / 3csken11.zip / WCSKENO.DOC < prev    next >
Text File  |  1995-02-05  |  20KB  |  483 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.      _____________________________________________________________________
  19.  
  20.  
  21.  
  22.  
  23.                                 WCS Keno v1.1
  24.                                         
  25.                                   Written by
  26.  
  27.                                  Rob Williams
  28.                                  WCS Software
  29.  
  30.  
  31.      _____________________________________________________________________
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.                               Table of Contents
  53.                               -----------------
  54.  
  55.      Copyright Notice...................................................  1
  56.  
  57.      Warranty...........................................................  1
  58.  
  59.      Features of WCS Keno...............................................  2
  60.  
  61.      Files used in the program..........................................  3
  62.  
  63.      Setting up WCS Keno................................................  4
  64.  
  65.      Setting up WCS Keno for Multinode Play.............................. 5
  66.  
  67.      Playing the game...................................................  6
  68.  
  69.      Make-Up Days Explanation...........................................  7
  70.  
  71.      Special Keys.......................................................  8
  72.  
  73.      Support............................................................  9
  74.  
  75.      Registering WCS Keno...............................................  9
  76.  
  77.      Acknowledgements...................................................  10
  78.  
  79.  
  80.                           
  81.                             Copyright Notice
  82.                             ----------------
  83.  
  84.      This door game is distributed under the SHAREWARE concept.  This
  85.      concept gives you the chance to "try before you buy", and see if it
  86.      meets your needs.  
  87.  
  88.      I've decided to break away from the standard "30 day trial period"
  89.      that many door authors are using and instead go to a much simpler 
  90.      and more realistic policy. This is simply; Try it on your BBS.
  91.      If you like it and your users like it, then register it.  If it's not 
  92.      good enough to register, then delete it.  
  93.  
  94.      While I'd like you to register my doors as soon as possible, I'm also 
  95.      realistic enough to know that different boards have different requirements
  96.      and interests, and sometimes it takes longer befor a game catches on, or a
  97.      sysop can get to the Doors on his list to register.  And frankly, I'd 
  98.      rather you ran it for awhile and register, than try it for a short 
  99.      period of time and delete it. Nobody wins that way...I lose out on a 
  100.      registration and your users lose out on the chance of having the 
  101.      registered door to play.
  102.  
  103.      The above "extended trial" statement was copied with permission from
  104.      Mike Jordan of M&S Doors.
  105.  
  106.      As a shareware  program, WCS Keno may be freely distributed.
  107.      Shareware distributors may distribute copies of WCS Keno on disk
  108.      for a modest disk duplication charge not to exceed $4 per disk.
  109.  
  110.  
  111.  
  112.                                     Warranty
  113.                                     --------
  114.  
  115.      WCS Keno is distributed on as as is basis.  In no event will
  116.      Rob Williams or WCS Software be liable to you for damages, including 
  117.      any loss of profits, lost savings, or other incidental or  
  118.      consequential damages arising out of your use of or inability to use 
  119.      this program, even if Rob Williams, WCS Software, or an authorized 
  120.      representative has been advised of the possibility of such damages.  
  121.      Rob Williams and WCS Software will not be liable for any such claim 
  122.      by any other party.
  123.  
  124.  
  125.                           Features of WCS Keno
  126.                           --------------------
  127.  
  128.      Assembly language serial input/output routines for maximum speed.
  129.  
  130.      Fully supports high speed modems: 16550 FIFO buffering and locked
  131.      serial ports.
  132.  
  133.      Built in ANSI terminal emulator.  No need to have ANSI.SYS loaded in
  134.      memory.
  135.  
  136.      DesqView, Windows, and OS/2 aware.
  137.  
  138.      Supports all of the most popular door data file formats:
  139.      TriBBS, PCBoard, GAP  (DOOR.SYS), Spitfire, WildCat!,  RBBS, and WWIV.
  140.  
  141.      ANSI and ASCII Bulletins of high scorers.
  142.  
  143.      Automatic maintenance with no intervention from the Sysop.
  144.  
  145.      Supports play ahead and make up days when registered.  This is
  146.      completely sysop configurable.
  147.  
  148.      WCS Keno is Multinode Aware!
  149.  
  150.  
  151.                          Files used in the Program
  152.                          -------------------------
  153.  
  154.      WCSKENO.EXE   -   The main WCS Keno program
  155.  
  156.      REGISTER.FRM  -   Information on registration
  157.  
  158.      SAMPLE.CFG    -   Sample configuration file
  159.  
  160.      SAMPLE.BAT    -   Sample batch file to run WCS Keno
  161.  
  162.      HISCORE.DAT   -   Created when the program runs-contains hi score info
  163.  
  164.      KENOUSER.DAT  -   Created when the program runs-contains user info
  165.  
  166.      WCSKENO.KEY   -   Key file for registered versions
  167.  
  168.      WCSKENO.USE   -   Created when the game is running, will be deleted
  169.                        when the user exits normally.
  170.                        (only in single user/non-registered versions)
  171.      
  172.      *************************************************************************
  173.      ** IMPORTANT - The game will not run if this file (WCSKENO.USE) exists **
  174.      *************************************************************************
  175.  
  176.      WCSKENO.HLP   -   Help file for the game.  When the Instructions option
  177.                        is selected, this file is displayed.  You may edit
  178.                        this file if you wish.  It is a plain ASCII text file.
  179.  
  180.      WCSKENO.HIS   -   History of the product.  Shows what enhancements were
  181.                        made in what version.
  182.  
  183.      WCSINFO.TXT   -   A text file explaining more about WCS Software and 
  184.                        showing all currently available WCS Software programs.
  185.  
  186.      READ.ME       -   A brief text file explaining how to get up and running
  187.                        quickly.
  188.  
  189.  
  190.                            Setting up WCS Keno
  191.                            -------------------
  192.  
  193.      WCS Keno is run by  entering a command similar to the
  194.      following:
  195.       
  196.      WCSKENO WCSKENO.CFG
  197.  
  198.      The configuration file can have any name you choose, but it must
  199.      reside in the same directory as the door.  The configuration file is
  200.      an ASCII text file with the following format:
  201.  
  202.      Line 1:   Door data file type.
  203.      Line 2:   Path to the door data file(s).
  204.      Line 3:   BBS name.
  205.      Line 4:   Sysop's name.
  206.      Line 5:   Locked baud rate.
  207.      Line 6:   ASCII High Score Bulletin Name
  208.      Line 7:   ANSI High Score Bulletin Name
  209.      Line 8:   Name and path of sysop feedback file
  210.      Line 9:   Number of Games per day
  211. *    Line 10:   Number of extra days allowed for make up days
  212. *    Line 11:  Day to start playing make up days-31 to disable
  213.      Line 12:  Write log files (explained below)
  214. *    Line 13:  Line to display a message (donated by, etc)
  215.  
  216.      Lines with a "*" to the left indicate features only present in the
  217.      registered version of the program.  *** The lines must be present,
  218.      even if the door is not registered. ***
  219.  
  220.      As illustrated above, the door's data file type is specified in line 1
  221.      and can be PCB for PCBoard, GAP for GAP (DOOR.SYS), SF for Spitfire,
  222.      RBBS for RBBS, WC for WildCat!, TRIBBS for TriBBS, or WWIV for WWIV. 
  223.      The locked baud rate is specified in line 5.  If you don't lock your
  224.      serial port, you must specify 0 for the locked baud rate.  
  225.      The following is a sample door configuration file:
  226.  
  227.      ************************************************************************
  228.      ** IMPORTANT - If you are running WC 4.x, use the GAP drop file       **
  229.      ************************************************************************
  230.  
  231.      WC                             <== BBS Type
  232.      C:\WC30\WCWORK\NODE1           <== Drop file location
  233.      WCS Software BBS               <== BBS Name
  234.      Rob Williams                   <== Sysop Name
  235.      0                              <== Locked baud rate
  236.      C:\WC30\BULL\BULL10.BBS        <== ASCII bulletin
  237.      C:\WC30\BULL\BULL10.SCR        <== ANSI bulletin
  238.      C:\WC30\COMMENTS.DRS           <== Feedback file
  239.      10                             <== # of questions per day
  240.      2                              <== Extra days allowed for make up days
  241.      10                             <== Day to start make up days
  242.      A                              <== Write a log file (See Below)
  243.      By WCS Software                <== Donated by line
  244.      ************************************************************************
  245.      ** IMPORTANT - Even if the game is not registered, the last  two      **
  246.      ** lines must exist, or the game will not run.  You will get an error **
  247.      ** when the game starts up.                                           **
  248.      ************************************************************************      
  249.  
  250.      On line 11, the valid options for a log file are:
  251.         - P for Play log ONLY  (WCSKENO.nodenumber)
  252.         - N for No logs
  253.         - C for Comments log ONLY 
  254.         - A for ALL Logs (play log and comment log)
  255.  
  256.      WCS Keno can be run locally without a door data file (handy
  257.      for the sysop to use the door without logging on to the BBS) by
  258.      specifying /L after the  configuration  file  parameter in  the  DOS 
  259.      command line.  WCS Keno will request you to enter your name before
  260.      running the door.
  261.  
  262.      To play the game in Multiuser mode, you must have a registered multinode 
  263.      copy,and DOS SHARE must be loaded.  If these two things are not done,  
  264.      the game will display a message if you try to run multinode.
  265.  
  266.      Nonstandard IRQs can be used by specifying the IRQ number after the 
  267.      "config" parameter in the command line used to run the door as
  268.      follows:
  269.  
  270.      WCSKENO WCSKENO.CFG 4
  271.  
  272.               Setting up WCS Keno for Multinode Play
  273.               --------------------------------------
  274.  
  275.     In order to set WCS Keno up for multinode play, you need to create a
  276.     .cfg file for each node that will be using the game.  The .cfg files
  277.     will be similar, except that lines 2 and possibly 5 will be different.
  278.     Line 2 is the location of the door drop file.  This needs to be unique
  279.     for each node that runs the game.  Line 5 is the locked baud rate for
  280.     the node.  If you have nodes that are locked at different rates, then
  281.     this line may be different for different nodes.  For example, the
  282.     configuration file for node 1 (WCSKENO.CF1) might look like this:
  283.  
  284.       GAP
  285.       H:\WILDCAT\WCWORK\NODE1     <=== Notice this is the node 1 directory
  286.       Williams Computer Services BBS
  287.       Rob Williams
  288.       19200
  289.       [etc].....
  290.  
  291.     And the configuration file for node 2 (WCSKENO.CF2) might look like this:
  292.  
  293.       GAP
  294.       H:\WILDCAT\WCWORK\NODE2     <=== Notice this is the node 2 directory
  295.       Williams Computer Services BBS
  296.       Rob Williams
  297.       19200
  298.       [etc].....
  299.  
  300.     You will also need to set an environment variable to tell the program
  301.     what node it is currently running on.  Since I run Wildcat, I call
  302.     this variable WCNODEID.  In my .BAT file that calls the BBS, I set the
  303.     WCNODEID to whatever node is running.  You can use wahtever name you
  304.     wish, it just needs to be a unique node ID.
  305.  
  306.     Next, in the batch file that calls WCS Keno, you would change the sample.bat
  307.     that is included with this archive to look like this:
  308.  
  309.        CD\WCSKENO
  310.        WCSKENO WCSKENO.CF%WCNODEID%
  311.  
  312.     What this will do, is when the game is started, it will look for the
  313.     WCNODEID (or whatever you called it), and append that to WCSKENO.CF.  So
  314.     when the game runs, and you run it from node 1 say, it will use .cfg file
  315.     WCSKENO.CF1.
  316.  
  317.     Hopefully, I have not totally confused you on how to set the door up for
  318.     mult-node use.  If you have questions on environment variables, refer
  319.     to your DOS manual.
  320.  
  321.    **************************************************************************
  322.    ** Running this game on more than a single node requires a Multi-Node   **
  323.    ** Key.  When running in Evaluation mode, only one (1) Node will be able**
  324.    ** to access the door at a time.                                        **
  325.    **************************************************************************
  326.  
  327.  
  328.                             Playing the Game
  329.                             ----------------
  330.      WCS Keno is very simple to play.  When you enter the door, you
  331.      come to a menu of four options.  They are:
  332.  
  333.        P)lay WCS Keno - Starts the game
  334.        H)igh scores - Shows the high score bulletin
  335.        I)nstructions - Displays this file
  336.        Q)uit - Exits the game
  337.  
  338.  
  339.      Available Keys
  340.      --------------
  341.      After choosing the "P" option from the main menu, you are brought to the
  342.      main Keno screen.  From this screen there are four options:
  343.  
  344.        [R]edraw Screen - Redraws the screen if you get line noise, etc.
  345.        Hi[G]h scores - Shows the high score bulletin
  346.        [I]nstructions - Displays this file
  347.        [Q]uit - Exits the game
  348.        [C]omputer pick numbers
  349.  
  350.      After choosing [P]lay, you will be asked to choose your spots.  You use the
  351.      8,6,4 and 2 keys to move the highlight around to the desired number.  When
  352.      a number is highlighted, you press enter or the space bar to select it.  The
  353.      number will turn a different color.  Continue choosing numbers like this, or
  354.      you can choose [C] to let the computer choose your numbers.  After 8 numbers
  355.      have been picked, you will see the computer picks hi-lited, your picks hi-lited
  356.      in a different color, and the ones you matched in a third color.  The object is
  357.      to match as many different colors as possible.  You continue on playing games
  358.      until you run out of games to play for today, or you choose [Q]uit.  Then you
  359.      will be asked if you want to view the high scores.  Then you will be returned
  360.      to the BBS.
  361.  
  362.  
  363.      Scoring
  364.      -------
  365.      Scoring is very simple.  The more money you accumulate, the higher your
  366.      score.  The scores are reset once a month.
  367.  
  368.      When you go into the door, you will see an opening screen, it will
  369.      wait for you to press a key, then show you the main menu.  From here,
  370.      there are four options.  P will take you to the playing screen, H will
  371.      show you the high score list, I will show you a help file for playing
  372.      the game, and Q will return you to the BBS.
  373.  
  374.      The first time a player plays the game each month, the system will
  375.      automatically reset the player statistics.  This process should not
  376.      take more than a few seconds, and is automatic, so no intervention
  377.      from the Sysop is necessary.
  378.  
  379.                            Make-Up Days Explanation
  380.                            ------------------------
  381.  
  382.      The make up days feature warrants a little more explanation here.
  383.      When the game is registered, after you have played your game for today,
  384.      it will check to see if make up days has been enabled (start day < 31).
  385.      If today is greater than the start day, and the total number of days you
  386.      have played is not greater than what was specified in the .cfg file, it
  387.      will ask you if you want to play a make up day.  It will then show a
  388.      calendar of days for the current month.  Days that you have played will
  389.      show up in red with an x, playable days will show up in green with an o.
  390.      Choose a valid date (one with an o, within the current month), and you
  391.      will start another days game.  If you changed your mind and do not want
  392.      to play a make up day, enter 99, and you will be asked if you want to
  393.      view the high scores, then be returned to the BBS.
  394.                             
  395.                               Special Keys
  396.                               ------------
  397.                                     
  398.      While WCS Keno is running, the sysop can press certain special keys to
  399.      perform a variety of functions.   The following is a list of the
  400.      functions that the special keys perform:
  401.  
  402.      Key(s)              Function
  403.  
  404.      HOME                Toggles between the user  status window and a help
  405.                          display that lists the special keys.
  406.  
  407.      F6                  Takes 5 minutes away from the caller.
  408.                          NOTE:  This will NOT be returned to BBS.
  409.  
  410.      F7                  Gives 5 minutes to the caller.
  411.                          NOTE:  This will NOT be returned to the BBS.
  412.  
  413.      F9                  Quit the door and return the caller to the BBS.
  414.  
  415.      F10                 Enter  chat mode.  Pressing the  ESC key exits the
  416.                          chat mode.
  417.  
  418.      Alt+D               Drop to DOS.
  419.  
  420.                                  
  421.                                 Support
  422.                                 -------
  423.  
  424.      If you have problems, I will try and help as best I can, whether you
  425.      are registered or not.  Registered users will get priority over non-
  426.      registered users, though.  You may get help with problems by calling 
  427.      Williams Computer Services BBS at (503) 631-8439, or by writing to 
  428.      the author at the following addresses:
  429.  
  430.      FIDO     : 1:105/278
  431.  
  432.      Internet : rob@wcs.org
  433.  
  434.      US Mail:
  435.  
  436.           Rob Williams
  437.           18370 S. Henrici Road
  438.           Oregon City, OR 97045
  439.  
  440.  
  441.                        Registering WCS Keno
  442.                        -------------------------
  443.  
  444.      Registration of WCS Keno is only $10.00 for single node
  445.      or $15.00 for Multi-Node.   Please use the form in the file
  446.      REGISTER.FRM.   When  you register,  you will receive a registration
  447.      key that will turn your version into a registered version.
  448.  
  449.      Registered users will have access to the special area of the support
  450.      BBS for additional questions, and also be able to add new questions,
  451.      edit questions and users, print questions and users, and import and
  452.      export questions.
  453.  
  454.  
  455.         ***** ALL UPDATES ARE FREE FOR THE LIFE OF THE PROGRAM *****
  456.  
  457.                             Acknowledgements
  458.                             ----------------
  459.  
  460.  Thanks go to the following people/companies (Listed in no particular order):
  461.  
  462.           - Mustang Software for creating Wildcat!
  463.           - Randy Hunt and Mark Goodwin for creating RMDoor which was used
  464.             to create this game.
  465.           - Mike Jordan for his help with some of the routines, and for the
  466.             idea of the make up days, and also help in testing, and his help 
  467.             in helping me get started in door programming.
  468.           - Andy Stewart for his programming help, and also for creating the
  469.             main play screen.
  470.           - Gayle Davis and all the people that have contributed to the
  471.             SWAG archives.  I have used various snippets from those
  472.             archives, as well as them giving me good ideas on how to
  473.             proceed next.  Thank you.
  474.           - A Big thank you to all my beta testers:
  475.                Norman Scott at 1:375/8
  476.                Walter Cade at 1:398/2
  477.                Mike Jordan at 1:105/314
  478.                Andy Stewart
  479.  
  480. There are probably more people that I have forgotten, but these have been
  481. the most instrumental in the writing of this program.
  482.  
  483.